Add Markdown link checking#655
Open
beanscg wants to merge 4 commits into
Open
Conversation
Co-authored-by: OpenAI Codex <287763725+beanscg@users.noreply.github.com>
# Conflicts: # CHANGELOG.md
Collaborator
Collaborator
|
^ *#654 |
This was referenced Jul 3, 2026
sadamov
reviewed
Jul 14, 2026
Comment on lines
+1
to
+8
| include_fragments = "full" | ||
| timeout = 20 | ||
|
|
||
| exclude = [ | ||
| "^https://join\\.slack\\.com/t/ml-lam/shared_invite/", | ||
| "^https://kutt\\.to/mllam$", | ||
| "^https://pyg\\.org/?$", | ||
| ] |
Collaborator
There was a problem hiding this comment.
Two small asks here.
Could we move this to .github/lychee.toml to keep the repo root tidy, and update the pre-commit --config path to match?
And on speed: lychee is the slowest hook, almost all of it CHANGELOG.md, where 142 of 199 links are mllam/neural-lam/(pull|issues)/N self-references re-checked on every PR. They are auto-generated and always resolve, so I suggest to exclude them. That takes CHANGELOG from ~15s to ~0.4s:
Suggested change
| include_fragments = "full" | |
| timeout = 20 | |
| exclude = [ | |
| "^https://join\\.slack\\.com/t/ml-lam/shared_invite/", | |
| "^https://kutt\\.to/mllam$", | |
| "^https://pyg\\.org/?$", | |
| ] | |
| include_fragments = "full" | |
| timeout = 20 | |
| exclude = [ | |
| "^https://join\\.slack\\.com/t/ml-lam/shared_invite/", | |
| "^https://kutt\\.to/mllam$", | |
| "^https://pyg\\.org/?$", | |
| "^https://github\\.com/mllam/neural-lam/(issues|pull)/\\d+/?$", | |
| ] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
Add the official lychee pre-commit hook for Markdown links with fragment checking enabled.
Add a PR-template reminder to update contributor workflow docs when those workflows change.
Fix two existing local Markdown links so the new hook passes on the current tree.
Issue Link
Closes #654.
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee
Verification
uvx pre-commit run check-yaml --files .pre-commit-config.yamluvx pre-commit run lychee --all-filesuvx pre-commit run trailing-whitespace --files .pre-commit-config.yaml .github/pull_request_template.md README.md CHANGELOG.md lychee.tomluvx pre-commit run end-of-file-fixer --files .pre-commit-config.yaml .github/pull_request_template.md README.md CHANGELOG.md lychee.tomluvx pre-commit run codespell --files .pre-commit-config.yaml .github/pull_request_template.md README.md CHANGELOG.md lychee.tomlgit diff --check